Central_Accel_AL.h

Go to the documentation of this file.

#ifndef CENTRAL_ACCEL_AL_H_
#define CENTRAL_ACCEL_AL_H_

/*
 **************************************************************
 * Defines, Macros and Typedefs 
 **************************************************************/
/*** Constant Macros ***/
/* Default Yes and No defines */
#ifndef TRUE
 #define TRUE (1u)
#endif
#ifndef CLEAR
 #define CLEAR (0u)
#endif
#ifndef BITS_IN_NIBBLE
 #define BITS_IN_NIBBLE (4u)
#endif
#ifndef BITS_IN_BYTE
 #define BITS_IN_BYTE (8u)
#endif
#ifndef BYTES_IN_16
 #define BYTES_IN_16  (2u)
#endif
#ifndef BYTES_IN_32
 #define BYTES_IN_32  (4u)
#endif

#ifndef BIT_DEFINITION
 #define BIT_DEFINITION
 #define BIT0  (1u << 0u)
 #define BIT1  (1u << 1u)
 #define BIT2  (1u << 2u)
 #define BIT3  (1u << 3u)
 #define BIT4  (1u << 4u)
 #define BIT5  (1u << 5u)
 #define BIT6  (1u << 6u)
 #define BIT7  (1u << 7u)
 #define BIT8  (1u << 8u)
 #define BIT9  (1u << 9u)
 #define BIT10 (1u << 10)
 #define BIT11 (1u << 11)
 #define BIT12 (1u << 12)
 #define BIT13 (1u << 13)
 #define BIT14 (1u << 14)
 #define BIT15 (1u << 15)
 #define BIT16 (1u << 16)
 #define BIT17 (1u << 17)
 #define BIT18 (1u << 18)
 #define BIT19 (1u << 19)
 #define BIT20 (1u << 20)
 #define BIT21 (1u << 21)
 #define BIT22 (1u << 22)
 #define BIT23 (1u << 23)
 #define BIT24 (1u << 24)
 #define BIT25 (1u << 25)
 #define BIT26 (1u << 26)
 #define BIT27 (1u << 27)
 #define BIT28 (1u << 28)
 #define BIT29 (1u << 29)
 #define BIT30 (1u << 30)
 #define BIT31 (1u << 31)
#endif

/* Following define can be set to MESQUITE or SYCAMORE depending on the board */
#define CURRENT_CA   SYCAMORE
#define CURRENT_ACCEL_MODE  3u

#ifndef STATUS_CA_FAILED
#define STATUS_CA_FAILED                (BIT27 | BIT26)
#endif

/*** Function Macros ***/
#ifndef N_ELEMENTS
 #define N_ELEMENTS(X)           (sizeof(X)/sizeof(*(X)))
#endif

/* The following define will mask the existence of Y as a true fn.  We are */
/* really calling the X function.                                          */
#define u32fnExtractY             u32fnExtractX

/*** Enums ***/


/*** TypeDefs ***/

/*
 **************************************************************
 * Declarations 
 **************************************************************/
/*** Global ***/
/*** Static ***/

/*** Constant ***/
extern const uint16_t cau16MMA6800ResetSettings[];
extern const uint16_t cau16MMA6800InitSettings[];
extern const uint8_t cu8SizeofMMA6800ResetSettings;
extern const uint8_t cu8SizeofMMA6800InitSettings;

/*
 **************************************************************
 * Function Prototypes 
 **************************************************************/
/*
 ******************************************************************************
 *
 * Function:          vfnCAPreSchedulerInit()
 *
 */
void vfnCAPreSchedulerInit(void);
/*
 ******************************************************************************
 *
 * Function:          u8fnCAInit()
 *
 */
uint32_t u32fnCAInit(void);
/*
 ******************************************************************************
 *
 * Function:          u32fnCAScheduleAccelXY()
 *
 */
uint32_t u32fnCAScheduleAccelXY(uint16_t* pu16RawDestination);
/*
 ******************************************************************************
 *
 * Function:          u32fnCAScheduleAccelX()
 *
 */
uint32_t u32fnCAScheduleAccelX(uint16_t* pu16RawDestination);
/*
 ******************************************************************************
 *
 * Function:          u32fnCAScheduleAccelY()
 *
 */
uint32_t u32fnCAScheduleAccelY(uint16_t* pu16RawDestination);
/*
 ******************************************************************************
 *
 * Function:          u32fnCAExtractXY()
 *
 */
uint32_t u32fnCAExtractXY(uint16_t* pu16RawSource, uint16_t* pu16FilteredXY);
/*
 ******************************************************************************
 *
 * Function:          u32fnCAExtractX()
 *
 */
uint32_t u32fnCAExtractX(uint16_t* pu16RawSource, uint16_t* pu16FilteredX);
/*
 ******************************************************************************
 *
 * Function:          u32fnCAInitSelfTest()
 *
 */
uint32_t u32fnCAInitSelfTest(void);
/*
 ******************************************************************************
 *
 * Function:          u32fnCASelfTest()
 *
 */
uint32_t u32fnCASelfTest(const uint8_t cu8Axis);
#endif /* CENTRAL_ACCEL_AL_H_ */